<?php defined('SYSPATH') or die('No direct script access.');

/**
 * Represents the required pieces of an HTTP response provided by HTTP transport
 * implementations and then consumed by the Http_Response class which provides
 * decoding
 */
class Http_Responses
{
	/**
	 * Status Messages indexed by Status Code
	 * Obtained from: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
	 *
	 * @var array
	 */
	static private $_default_status_messages = array(
		// Specific to PHP Solr Client
		0 => "Communication Error",

		// Informational 1XX
		100 => "Continue",
		101 => "Switching Protocols",

		// Successful 2XX
		200 => "OK",
		201 => "Created",
		202 => "Accepted",
		203 => "Non-Authoritative Information",
		204 => "No Content",
		205 => "Reset Content",
		206 => "Partial Content",

		// Redirection 3XX
		300 => "Multiple Choices",
		301 => "Moved Permanently",
		302 => "Found",
		303 => "See Other",
		304 => "Not Modified",
		305 => "Use Proxy",
		307 => "Temporary Redirect",

		// Client Error 4XX
		400 => "Bad Request",
		401 => "Unauthorized",
		402 => "Payment Required",
		403 => "Forbidden",
		404 => "Not Found",
		405 => "Method Not Allowed",
		406 => "Not Acceptable",
		407 => "Proxy Authentication Required",
		408 => "Request Timeout",
		409 => "Conflict",
		410 => "Gone",
		411 => "Length Required",
		412 => "Precondition Failed",
		413 => "Request Entity Too Large",
		414 => "Request-URI Too Long",
		415 => "Unsupported Media Type",
		416 => "Request Range Not Satisfiable",
		417 => "Expectation Failed",

		// Server Error 5XX
		500 => "Internal Server Error",
		501 => "Not Implemented",
		502 => "Bad Gateway",
		503 => "Service Unavailable",
		504 => "Gateway Timeout",
		505 => "HTTP Version Not Supported"
	);

	/**
	 * Get the HTTP status message based on status code
	 *
	 * @return string
	 */
	public static function get_default_status_message($status_code)
	{
		$status_code = (int) $status_code;

		if (isset(self::$_default_status_messages[$status_code]))
		{
			return self::$_default_status_messages[$status_code];
		}

		return "Unknown Status";
	}

	/**
	 * The response's HTTP status code
	 *
	 * @var integer
	 */
	private $_status_code;

	/**
	 * The response's HTTP status message
	 *
	 * @var string
	 */
	private $_status_message;

	/**
	 * The response's mime type
	 *
	 * @var string
	 */
	private $_mime_type;

	/**
	 * The response's character encoding
	 *
	 * @var string
	 */
	private $_encoding;

	/**
	 * The response's data
	 *
	 * @var string
	 */
	private $_response_body;

	/**
	 * Construct a HTTP transport response
	 *
	 * @param integer $status_code The HTTP status code
	 * @param string $content_type The VALUE of the Content-Type HTTP header
	 * @param string $response_body The body of the HTTP response
	 */
	public function __construct($status_code, $content_type, $response_body)
	{
		// set the status code, make sure its an integer
		$this->_status_code = (int) $status_code;

		// lookup up status message based on code
		$this->_status_message = self::get_default_status_message($this->_status_code);

		// set the response body, it should always be a string
		$this->_response_body = (string) $response_body;

		// parse the content type header value for mime_type and encoding
		// first set default values that will remain if we can't find
		// what we're looking for in the content type
		$this->_mime_type = "text/plain";
		$this->_encoding = "UTF-8";

		if ($content_type)
		{
			// now break apart the header to see if there's character encoding
			$content_type_parts = explode(';', $content_type, 2);

			if (isset($content_type_parts[0]))
			{
				$this->_mime_type = trim($content_type_parts[0]);
			}

			if (isset($content_type_parts[1]))
			{
				// we have a second part, split it further
				$content_type_parts = explode('=', $content_type_parts[1]);

				if (isset($content_type_parts[1]))
				{
					$this->_encoding = trim($content_type_parts[1]);
				}
			}
		}
	}

	/**
	 * Get the status code of the response
	 *
	 * @return integer
	 */
	public function get_status_code()
	{
		return $this->_status_code;
	}

	/**
	 * Get the status message of the response
	 *
	 * @return string
	 */
	public function get_status_message()
	{
		return $this->_status_message;
	}

	/**
	 * Get the mime_type of the response body
	 *
	 * @return string
	 */
	public function get_mime_type()
	{
		return $this->_mime_type;
	}

	/**
	 * Get the charset encoding of the response body.
	 *
	 * @return string
	 */
	public function get_encoding()
	{
		return $this->_encoding;
	}

	/**
	 * Get the raw response body
	 *
	 * @return string
	 */
	public function get_body()
	{
		return $this->_response_body;
	}

}
